home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / basic / ace_prgs.lha / games / cardmaster.lha / cardmaster.doc < prev    next >
Encoding:
Text File  |  1994-12-11  |  6.9 KB  |  173 lines
  1. ****
  2. *
  3. *  CardMaster 1.2
  4. *
  5. *  © Rich Allen  11/1994
  6. *
  7. ****
  8.  
  9.  
  10.    These docs provide a general overview on how to use the CardMaster database
  11. program to keep track of your Magic:The Gathering® card collection.
  12.    
  13.    Version 1.1 fixes a problem with the gadget sizes.  They are now formatted 
  14. for the Topaz8 font, which is the Workbench default.
  15.  
  16.    Version 1.2 removes the '&' from structure variables as they are unnecessary
  17. and might be confusing to anyone looking through the code.  It also now uses
  18. the Topaz 8 font in all windows, to avoid format problems on non-standard
  19. Workbench screens.
  20.  
  21.  
  22. Installation:
  23.    Couldn't be easier.  You can place the executable in any directory you like.
  24. The datafiles should probably be kept in the same directory as the executable,
  25. but it isn't necessary to do so.
  26.  
  27.  
  28. The program:
  29.    You can start CardMaster from the shell or from Workbench.  CardMaster opens
  30. a window on the workbench, displaying several buttons which control every
  31. function in the program.  Initially, only the Quit and Load Database buttons are 
  32. active.  Each button is detailed below.
  33.  
  34.    - LOAD DATABASE:  Clicking on this button opens a file requestor which allows
  35. you to select a cardlist file.  Once a cardlist file has been loaded, this
  36. button becomes inactive and the rest of the buttons are activated.  Included
  37. in this archive are two cardlists; cardlist.start has all cards from the Revised
  38. and Unlimited releases, as well as expansion sets up to The Dark.  Cardlist.rich
  39. is a smaller listing of my card collection, with cards from the Revised, The Dark
  40. and Legends card sets. 
  41.  
  42.    - SAVE DATABASE:  Clicking on this button opens a file requestor, from which
  43. you can either type in a new filename or select an existing file to overwrite.
  44. It is suggested that you name your cardlist files as cardlist.[database name], 
  45. e.g. cardlist.rich, for clarity, but you can choose any filename you like.
  46.  
  47.    - COUNT TO PRT:  Clicking this button causes the program to create a
  48. statistical list of cards.  It counts the total number of cards per set and
  49. color, the number of unique cards per set and color, and the total/unique 
  50. numbers by rarity.  A small window is opened showing the progress of the count
  51. and some limited count info, and sends to complete list to the printer.
  52. This operation assumes you have a printer connected and ready for printing.
  53. It does not check for the existance of a printer.
  54.  
  55.    - COUNT TO DISK:  Clicking this button accomplishes the same thing as the
  56. previous button, except that the list is saved to a file.  A file requestor is
  57. opened to allow you to type in a file name or choose an existing file to 
  58. overwrite.  Choosing cancel from the file requestor cancels this operation.
  59.  
  60.    - LIST TO PRT:  Clicking this button sends a list of every card in the
  61. database with a number greater than zero to the printer.  The list is sorted 
  62. by set and color.  This operation assumes you have a printer connected and
  63. ready for printing.  It does not check for the existance of a printer.
  64.  
  65.    - LIST TO DISK:  Clicking this button accomplishes the same thing as the
  66. previous button, except that the list is saved to a file.  A file requestor is
  67. opened to allow you to type in a file name or choose an existing file to 
  68. overwrite.  Choosing cancel from the file requestor cancels this operation.
  69.  
  70.    - ADD CARD:  Clicking this button adds one to the number field of the current
  71. card.  This indicates the number of cards you own of the current card.  You can
  72. have a maximum of 255 cards, further clicking will not advance the beyond 255.
  73.  
  74.    - SUB CARD:  Clicking this button subtracts one from the number field of the
  75. current card.  The minimum number is zero, further clicking will not decrement
  76. the count below zero.
  77.  
  78.    - NEXT CARD:  Clicking on this button will advance the display to the next
  79. card in the database.  When the last card in the cardlist is reached, clicking
  80. this button will wrap to the first card in the list.
  81.  
  82.    - PREV CARD:  Clicking on this button will move the display to the previous
  83. card in the database.  Clicking this button when the first card in the cardlist
  84. is displayed will wrap to the last card in the list.
  85.  
  86.    - QUIT:  Clicking this button will bring up a requestor asking if you really
  87. want to quit.  The program will not warn you if changes in the database haven't
  88. been saved.  It's a good idea to save the database before quitting, even if no
  89. changes have been made.  Further versions will include a warning.
  90.  
  91.  
  92. The datafiles:
  93.    CardMaster expects its datafiles to formatted in a very specific way; failure
  94. to follow these guidelines will have unpredictable results, and may cause a
  95. guru visit.
  96.    The very first line of the datafile must be the number of cards in the file.
  97. The rest of the file consists of card data, one card per line, in the following
  98. format:
  99.  
  100.      "011114","Badlands"
  101.  
  102.    The first field MUST be 6 characters long and surrounded by quotes, as shown.
  103. The second field is the card's name and must also be surrounded by quotes.  There
  104. must be a comma between the two fields.  The meaning of the first field is as
  105. follows:
  106.  
  107.   The first two positions is a hex value indicating the number of copies of that
  108. card in your collection.
  109.  
  110.   The third position is the card's color:
  111.      1 - Land
  112.      2 - Artifact
  113.      3 - Black
  114.      4 - Blue
  115.      5 - Green
  116.      6 - Red
  117.      7 - White
  118.      8 - Gold
  119.  
  120.   The fourth position is the spell type:
  121.      1 - Enchantment
  122.      2 - Instant
  123.      3 - Interrupt
  124.      4 - Sorcery
  125.      5 - Summon
  126.      6 - Artifact
  127.      7 - Artifact Creature
  128.  
  129.   The fifth position is the set the card came from:
  130.      1 - Revised
  131.      2 - The Dark
  132.      3 - Antiquities
  133.      4 - Arabian Nights
  134.      5 - Legends
  135.      6 - Unlimited
  136.      7 - Fallen Empires
  137.  
  138.   The sixth position is a hex value indicating the card's rarity:
  139.      1 - Land
  140.      2 - Common
  141.      3 - Uncommon
  142.      4 - Rare
  143.      5 - Common
  144.      6 - Common2
  145.      7 - Common3
  146.      8 - Common4
  147.      9 - Common5
  148.      A - Uncommon1
  149.      B - Uncommon2
  150.      C - Uncommon3
  151.      D - Uncommon4
  152.  
  153.   
  154. Future versions:
  155.    I plan on expanding the program to allow sorting the cards in several different
  156. ways.  Also in the works is a sub-program that allows adding and deleting cards
  157. to/from the datafile itself.
  158.    Version 1.2 will be the last revision to this initial release, barring any 
  159. further bugs.  Version 2.0 is being coded now, which will completely re-work
  160. the interface to allow for sorting, different methods of printing the list, and
  161. modification of the datafiles.  No promises on a release date though! :)
  162.  
  163. Other stuff:
  164.    This program was written in BASIC using the incredible ACE package by David
  165. Benn.  Version 1.2 was compiled with ACE 2.3, the latest release.
  166.    Magic: The Gathering, set names, and card names are copyrighted by Wizards
  167. of the Coast.  All rights to the card information belong to them, along with
  168. my thanks for a truly enjoyable game.
  169.  
  170.    Comments can be sent via e-mail to: rico@larry.cdsar.af.mil
  171.                                        rico@io.com
  172.  
  173.